[IMP] misc: IAP grammar updates and new image #7427

MaxKeilOdoo · 2024-01-17T16:35:24Z

CONTINUATION OF #6778

-Updated grammar and formatting throughout: removed 2nd person, added :guilabel:, etc
-Revised content to be more thorough, and met with Jose (job) to understand scope of what end users need the document to explain

robodoo · 2024-01-17T16:36:35Z

Pull request status dashboard.

MaxKeilOdoo · 2024-01-17T17:51:43Z

Hi @tiku-odoo , I had to make a new pr to resolve the check issues, but this is now actually ready for your review. Please let me know if you have any thoughts or suggestions.

Thank you.

tiku-odoo

@MaxKeilOdoo

Looks great Max. I have a couple suggestions, otherwise good to go. A manual walkthrough may be help as noted in comment #3.

Let me know if you have any questions!
Tim 👍

content/applications/general/in_app_purchase.rst

MaxKeilOdoo · 2024-01-17T20:41:19Z

Hi @tiku-odoo I'm made all your changes other than adding the optional section for manually triggering an IAP. This should be ready for second review so I am tagging @helpdesk-doc-review for that.

larm-odoo

Hi Max- all set with my review! I was using a 16.0 runbot- were you as well? Some of the steps did not appear the way I saw them, and made edits accordingly- but if I am not using the right version that may be why. Please feel free to ask any questions if anything is confusing! Great doc - I learned a lot on the IAP items- I didn't know much about them before =).

content/applications/general/in_app_purchase.rst

MaxKeilOdoo · 2024-01-18T23:17:32Z

@larm-odoo This is ready for you to take a second look. Zach and I changed the commit to be for 17.0, so the differences you encountered with 16.0 won't be an issue anymore.

I made all your other suggested changes, but please let me know if you have any other thoughts before I push it to Final Review.

Thank you!

content/applications/general/in_app_purchase.rst

larm-odoo

Hi @MaxKeilOdoo - not a lot to change, but I did find a few places where doing this in 17 instead of 16 presented slightly different information or words. I think I caught all the changes/differences between the two. Since I was adding review notes on top of a review, some are just comments I made because I couldn't add the in-line text, and some places I as able to. I hope it' snot too confusing!

content/applications/general/in_app_purchase.rst

larm-odoo · 2024-01-22T17:16:48Z

content/applications/general/in_app_purchase.rst

+#. Go to :menuselection:`Settings app --> search IAP --> View My Services --> Click on the
+   account`.


I can't seem to make a suggestion since this was already a comment, but I noticed in 17.0, it does not open in a new tab- it remains in the current tab, FYI.

larm-odoo · 2024-01-22T17:18:09Z

content/applications/general/in_app_purchase.rst

+      :align: center
+      :alt: The Account Information page for an IAP service showing the Buy Credit button.
+
+#. On the :guilabel:`Account Information` page, click the :guilabel:`Buy Credit` button.


Now in 17.0 you have to click on the service first, so I would add that direction. Again, I can't seem to add the suggestion in-line, sorry!

larm-odoo · 2024-01-22T17:31:04Z

content/applications/general/in_app_purchase.rst

+#. Go to :menuselection:`Settings app --> search IAP --> View My Services --> Click on the
+   account`.


I would also mention it displays the information in a list view- in 16 I remember it being in boxes, but now all the runbots "do not have any iap's" installed so I can't check.

content/applications/general/in_app_purchase.rst

MaxKeilOdoo · 2024-01-22T21:19:05Z

@ksc-odoo This should be ready for final review. Please let me know if you have any changes or suggestions. Thanks!

ksc-odoo

@MaxKeilOdoo Just finished my review on this PR. Great work explaining a somewhat complex feature. Nicely done. There are a handful of comments/suggestions that need your attention, but once you make those changes, feel free to tag me again for another look. Thanks! 👍

ALSO: I would add an [IMP] to the beginning of the title of this PR...

So it would be [IMP] 16.0 IAP Grammar Updates - remove 2nd person

content/applications/general/in_app_purchase.rst

MaxKeilOdoo · 2024-01-23T22:15:11Z

@ksc-odoo This is ready for your final review, let me know if anything else is needed before we pass it on for final approval/publication. Thanks!

ksc-odoo

@MaxKeilOdoo we're getting there! just need you to make some additional adjustments to this doc, and tag me again, before we can move it along. Also, correct me if I'm wrong, but I believe there are some screenshots/images that you aren't mentioning/using in the PR...If that's the case, I can show you how to properly remove those from the PR to save space....

If you have any questions, or need clarification on anything, just let me know. Thanks!

content/applications/general/in_app_purchase.rst

ksc-odoo · 2024-01-24T17:24:31Z

content/applications/general/in_app_purchase.rst

+.. image:: in_app_purchase/iap.png
   :align: center
+   :alt: The IAP catalog with various services available on IAP.Odoo.com.


move this image up -- as requested by the first comment on this PR

content/applications/general/in_app_purchase.rst

ksc-odoo · 2024-01-24T17:31:04Z

content/applications/general/in_app_purchase.rst

+- :guilabel:`Documents Digitization`: digitizes scanned or PDF vendor bills, expenses, and resumes
+  with OCR and AI.
+- :guilabel:`Lead Generation`: generates leads based on a set of criteria and converts web visitors
+  into quality leads and opportunities.
+- :guilabel:`Partner Autocomplete`: automatically populates contact records with corporate data.
+- :guilabel:`SMS`: sends SMS text messages to contacts directly from the database.
+- :guilabel:`Snailmail`: sends customer invoices and follow-up reports by post, worldwide.


I know/understand why the entire list isn't going to be laid out, but I think it might be best to list these in the same order they appear on the Catalog website that's being linked. So, I'd recommend re-ordering these.

content/applications/general/in_app_purchase.rst

MaxKeilOdoo · 2024-01-24T19:54:11Z

@ksc-odoo This is ready for another review. Thank you!

ksc-odoo

Alrighty @MaxKeilOdoo we are jussssst about there. Once you make these adjustments, and tag me again, this one should be ready for Tech Review! Awesome work on this one! 👍

content/applications/general/in_app_purchase.rst

MaxKeilOdoo · 2024-01-25T21:13:40Z

@ksc-odoo The changes you requested are made. Let me know if this can be passed off to the next stage of review.

Thank you.

ksc-odoo

Awesome work. Just 2 super minor "final-touches" -- but I'll go ahead and approve this now. Once you've made those changes, feel free to tag Sam for Tech Review 👍 Great work!

content/applications/general/in_app_purchase.rst

samueljlieber

Hi @MaxKeilOdoo! Awesome job on this PR! I have a handful of corrections, please see below, and let me know if you have any questions.

Also please note the extra file that was accidentally added in your squashing step, sometimes this can happen when pressing too many keys in the interactive rebase.

I will push up a commit with all of these changes to move this PR forward, but please review the suggestions I made 🙂 Thanks again and nice work!

samueljlieber · 2024-01-25T22:27:08Z

e -i HEAD~3

This file (e -i HEAD~3) was accidentally created while squashing. The file was placed in the root (documentation/) of the directory, and needs to be removed for the CI checks to pass 🙂

samueljlieber · 2024-01-25T22:28:54Z

content/applications/general/in_app_purchase.rst

You can use the dynamic #. instead of static 1. so that the number of bullets is automatically incremented, and is proffered

Suggested change

1. Navigate to the *Contacts* application, and click on a contact with a mobile phone number

entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the contact form.

2. Hover the mouse over the :guilabel:`Phone` or :guilabel:`Mobile` field, and a :guilabel:`📱

(phone) SMS` icon appears to the right.

3. Click the :guilabel:`📱 (phone) SMS` icon, and a :guilabel:`Send SMS Text Message` pop-up

window appears.

4. Type a message in the :guilabel:`Message` field of the :guilabel:`Send SMS Text Message`

pop-up window. Then, click the :guilabel:`Send SMS` button. Odoo then sends the message, via

SMS, to the contact, and logs what was sent in the *chatter* of the contact's form.

#. Navigate to the *Contacts* application, and click on a contact with a mobile phone number

entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the contact form.

#. Hover the mouse over the :guilabel:`Phone` or :guilabel:`Mobile` field, and a :guilabel:`📱

(phone) SMS` icon appears to the right.

#. Click the :guilabel:`📱 (phone) SMS` icon, and a :guilabel:`Send SMS Text Message` pop-up

window appears.

#. Type a message in the :guilabel:`Message` field of the :guilabel:`Send SMS Text Message`

pop-up window. Then, click the :guilabel:`Send SMS` button. Odoo then sends the message, via

SMS, to the contact, and logs what was sent in the *chatter* of the contact's form.

samueljlieber · 2024-01-25T22:30:56Z

content/applications/general/in_app_purchase.rst

These too

Suggested change

1. Go to the *Settings* application.

2. Type `IAP` in the search bar.

3. Click :guilabel:`View My Services`.

#. Go to the *Settings* application.

#. Type `IAP` in the search bar.

#. Click :guilabel:`View My Services`.

samueljlieber · 2024-01-25T22:31:29Z

content/applications/general/in_app_purchase.rst

Suggested change

1. Go to the *Settings* application.

2. Type `IAP` in the search bar.

3. Click :guilabel:`View My Services`.

4. The available IAP accounts appear in a list view on the :guilabel:`IAP Account` page. From here,

click on the desired IAP account to view that service's :guilabel:`Account Information` page.

5. On the :guilabel:`Account Information` page, tick the :guilabel:`Warn Me` box. Doing so reveals

two fields on the form: :guilabel:`Threshold` and :guilabel:`Warning Email`.

.. image:: in_app_purchase/low-credits.png

:align: center

:alt: Odoo will send an email alert when credits for this service fall below the threshold.

6. In the :guilabel:`Threshold` field, enter an amount of credits Odoo should use as the minimum

threshold for this service.

7. In the :guilabel:`Warning Email` field, enter the email address that should receive the

notification.

#. Go to the *Settings* application.

#. Type `IAP` in the search bar.

#. Click :guilabel:`View My Services`.

#. The available IAP accounts appear in a list view on the :guilabel:`IAP Account` page. From here,

click on the desired IAP account to view that service's :guilabel:`Account Information` page.

#. On the :guilabel:`Account Information` page, tick the :guilabel:`Warn Me` box. Doing so reveals

two fields on the form: :guilabel:`Threshold` and :guilabel:`Warning Email`.

.. image:: in_app_purchase/low-credits.png

:align: center

:alt: Odoo will send an email alert when credits for this service fall below the threshold.

#. In the :guilabel:`Threshold` field, enter an amount of credits Odoo should use as the minimum

threshold for this service.

#. In the :guilabel:`Warning Email` field, enter the email address that should receive the

notification.

samueljlieber · 2024-01-25T22:34:47Z

content/applications/general/in_app_purchase.rst

Add abbreviations throughout the doc

Suggested change

.. |IAP| replace:: :abbr:`IAP (In-app purchases)`

samueljlieber · 2024-01-25T22:36:14Z

content/applications/general/in_app_purchase.rst

The abbr shorthand can be used like this:

Suggested change

IAP services do **not** need to be configured or set up before use. Odoo users can simply click on

|IAP| services do **not** need to be configured or set up before use. Odoo users can simply click on

samueljlieber · 2024-01-25T22:40:28Z

content/applications/general/in_app_purchase.rst

Use menuselection when directing the user

Suggested change

1. Navigate to the *Contacts* application, and click on a contact with a mobile phone number

#. Navigate to the :menuselection:`Contacts application`, and click on a contact with a mobile

phone number entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the

contact form.

samueljlieber · 2024-01-25T22:41:16Z

content/applications/general/in_app_purchase.rst

Use menuselection when directing the user

Suggested change

1. Go to the *Settings* application.

#. Go to the :menuselection:`Settings application`.

samueljlieber · 2024-01-25T22:54:09Z

Implemented technical changes in 59d3561

@StraubCreative this PR is all set 👍

StraubCreative

Hi @MaxKeilOdoo
Great job on this doc.
I'm approving with two comments below, and will push up the quick change for the first comment momentarily for merge.
Thanks everyone for your hard work on this!

content/applications/general/in_app_purchase.rst

StraubCreative · 2024-01-26T00:37:46Z

content/applications/general/in_app_purchase.rst

Optional: might be useful to include TIKU's pricing table he unearthed recently for MMC team.

Co-authored-by: larm-odoo <121518652+larm-odoo@users.noreply.github.com> Co-authored-by: tiku-odoo <tiku@odoo.com> Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com> Co-authored-by: StraubCreative <zst@odoo.com>

StraubCreative · 2024-01-26T00:49:44Z

@robodoo r+

fw-bot · 2024-01-29T05:55:15Z

@MaxKeilOdoo @StraubCreative this pull request has forward-port PRs awaiting action (not merged or closed):

MaxKeilOdoo mentioned this pull request Jan 17, 2024

[IMP] misc: IAP grammar updates and new image #6778

Closed

MaxKeilOdoo force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch from 573596a to 6b6376a Compare January 17, 2024 17:16

MaxKeilOdoo changed the base branch from 17.0 to 16.0 January 17, 2024 17:48

C3POdoo requested a review from a team January 17, 2024 17:50

MaxKeilOdoo requested a review from tiku-odoo January 17, 2024 17:51

tiku-odoo approved these changes Jan 17, 2024

View reviewed changes

content/applications/general/in_app_purchase.rst Outdated Show resolved Hide resolved

content/applications/general/in_app_purchase.rst Outdated Show resolved Hide resolved

content/applications/general/in_app_purchase.rst Outdated Show resolved Hide resolved

MaxKeilOdoo force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch from 6b6376a to 8de0cbc Compare January 17, 2024 20:28

MaxKeilOdoo requested a review from a team January 17, 2024 20:41

larm-odoo reviewed Jan 18, 2024

View reviewed changes

MaxKeilOdoo force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch 2 times, most recently from 76bc0d6 to 970a743 Compare January 18, 2024 21:19

StraubCreative changed the base branch from 16.0 to 17.0 January 18, 2024 22:20

MaxKeilOdoo requested a review from larm-odoo January 18, 2024 23:15

lobaudoux reviewed Jan 22, 2024

View reviewed changes

content/applications/general/in_app_purchase.rst Outdated Show resolved Hide resolved

larm-odoo reviewed Jan 22, 2024

View reviewed changes

MaxKeilOdoo force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch 2 times, most recently from 943ca8e to 9d9f129 Compare January 22, 2024 21:00

ksc-odoo suggested changes Jan 23, 2024

View reviewed changes

MaxKeilOdoo force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch from 49831ef to a1e2436 Compare January 23, 2024 22:04

MaxKeilOdoo requested a review from ksc-odoo January 23, 2024 22:14

ksc-odoo suggested changes Jan 24, 2024

View reviewed changes

MaxKeilOdoo force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch from 9b1f1ef to 9efb37c Compare January 24, 2024 19:52

MaxKeilOdoo requested a review from ksc-odoo January 24, 2024 19:53

MaxKeilOdoo changed the title ~~16.0 iap grammar updates remove 2nd person nimk~~ [IMP] misc: IAP grammar updates and new image Jan 25, 2024

ksc-odoo suggested changes Jan 25, 2024

View reviewed changes

MaxKeilOdoo force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch from 8c327f8 to 79013cc Compare January 25, 2024 20:56

MaxKeilOdoo requested a review from ksc-odoo January 25, 2024 21:13

ksc-odoo approved these changes Jan 25, 2024

View reviewed changes

content/applications/general/in_app_purchase.rst Outdated Show resolved Hide resolved

content/applications/general/in_app_purchase.rst Outdated Show resolved Hide resolved

MaxKeilOdoo force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch from 0714ec4 to 3b9076f Compare January 25, 2024 22:12

C3POdoo requested a review from a team January 25, 2024 22:14

samueljlieber approved these changes Jan 25, 2024

View reviewed changes

samueljlieber force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch from 3b9076f to 59d3561 Compare January 25, 2024 22:50

samueljlieber requested a review from StraubCreative January 25, 2024 22:54

StraubCreative approved these changes Jan 26, 2024

View reviewed changes

[IMP] misc: IAP grammar updates and new image

561761c

Co-authored-by: larm-odoo <121518652+larm-odoo@users.noreply.github.com> Co-authored-by: tiku-odoo <tiku@odoo.com> Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com> Co-authored-by: StraubCreative <zst@odoo.com>

StraubCreative force-pushed the 16.0-iap-grammar-updates-remove-2nd-person-nimk branch from 59d3561 to 561761c Compare January 26, 2024 00:46

robodoo temporarily deployed to merge January 26, 2024 02:50 Inactive

robodoo closed this in 07333c0 Jan 26, 2024

This was referenced Jan 26, 2024

[FW][IMP] misc: IAP grammar updates and new image #7553

Closed

[FW][IMP] misc: IAP grammar updates and new image #7554

Closed

tiku-odoo mentioned this pull request Apr 17, 2024

[IMP] essentials: iap graphics update and rewrite #8812

Closed

		#. Go to :menuselection:`Settings app --> search IAP --> View My Services --> Click on the
		account`.

-. Navigate to the *Contacts* application, and click on a contact with a mobile phone number
-      entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the contact form.
-. Hover the mouse over the :guilabel:`Phone` or :guilabel:`Mobile` field, and a :guilabel:`📱
-      (phone) SMS` icon appears to the right.
-. Click the :guilabel:`📱 (phone) SMS` icon, and a :guilabel:`Send SMS Text Message` pop-up
-      window appears.
-. Type a message in the :guilabel:`Message` field of the :guilabel:`Send SMS Text Message`
-      pop-up window. Then, click the :guilabel:`Send SMS` button. Odoo then sends the message, via
-      SMS, to the contact, and logs what was sent in the *chatter* of the contact's form.
+   #. Navigate to the *Contacts* application, and click on a contact with a mobile phone number
+      entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the contact form.
+   #. Hover the mouse over the :guilabel:`Phone` or :guilabel:`Mobile` field, and a :guilabel:`📱
+      (phone) SMS` icon appears to the right.
+   #. Click the :guilabel:`📱 (phone) SMS` icon, and a :guilabel:`Send SMS Text Message` pop-up
+      window appears.
+   #. Type a message in the :guilabel:`Message` field of the :guilabel:`Send SMS Text Message`
+      pop-up window. Then, click the :guilabel:`Send SMS` button. Odoo then sends the message, via
+      SMS, to the contact, and logs what was sent in the *chatter* of the contact's form.

-. Go to the *Settings* application.
-. Type `IAP` in the search bar.
-. Click :guilabel:`View My Services`.
+#. Go to the *Settings* application.
+#. Type `IAP` in the search bar.
+#. Click :guilabel:`View My Services`.

-. Go to the *Settings* application.
-. Type `IAP` in the search bar.
-. Click :guilabel:`View My Services`.
-. The available IAP accounts appear in a list view on the :guilabel:`IAP Account` page. From here,
-   click on the desired IAP account to view that service's :guilabel:`Account Information` page.
-. On the :guilabel:`Account Information` page, tick the :guilabel:`Warn Me` box. Doing so reveals
-   two fields on the form: :guilabel:`Threshold` and :guilabel:`Warning Email`.
-   .. image:: in_app_purchase/low-credits.png
-      :align: center
-      :alt: Odoo will send an email alert when credits for this service fall below the threshold.
-. In the :guilabel:`Threshold` field, enter an amount of credits Odoo should use as the minimum
-   threshold for this service.
-. In the :guilabel:`Warning Email` field, enter the email address that should receive the
-   notification.
+#. Go to the *Settings* application.
+#. Type `IAP` in the search bar.
+#. Click :guilabel:`View My Services`.
+#. The available IAP accounts appear in a list view on the :guilabel:`IAP Account` page. From here,
+   click on the desired IAP account to view that service's :guilabel:`Account Information` page.
+#. On the :guilabel:`Account Information` page, tick the :guilabel:`Warn Me` box. Doing so reveals
+   two fields on the form: :guilabel:`Threshold` and :guilabel:`Warning Email`.
+   .. image:: in_app_purchase/low-credits.png
+      :align: center
+      :alt: Odoo will send an email alert when credits for this service fall below the threshold.
+#. In the :guilabel:`Threshold` field, enter an amount of credits Odoo should use as the minimum
+   threshold for this service.
+#. In the :guilabel:`Warning Email` field, enter the email address that should receive the
+   notification.

	IAP services do not need to be configured or set up before use. Odoo users can simply click on
	\|IAP\| services do not need to be configured or set up before use. Odoo users can simply click on

	1. Go to the Settings application.
	#. Go to the :menuselection:`Settings application`.

[IMP] misc: IAP grammar updates and new image #7427

[IMP] misc: IAP grammar updates and new image #7427

Uh oh!

Conversation

MaxKeilOdoo commented Jan 17, 2024

Uh oh!

robodoo commented Jan 17, 2024

Uh oh!

MaxKeilOdoo commented Jan 17, 2024

Uh oh!

tiku-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MaxKeilOdoo commented Jan 17, 2024

Uh oh!

larm-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MaxKeilOdoo commented Jan 18, 2024

Uh oh!

Uh oh!

larm-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MaxKeilOdoo commented Jan 22, 2024

Uh oh!

ksc-odoo left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MaxKeilOdoo commented Jan 23, 2024

Uh oh!

ksc-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ksc-odoo left a comment •

edited

Loading